<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\library\Session</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: "><span class="description">__construct()
        </span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#get" title="get :: "><span class="description">get()
        </span><pre>get()</pre></a></li>
<li class="method public "><a href="#getUserData" title="getUserData :: "><span class="description">getUserData()
        </span><pre>getUserData()</pre></a></li>
<li class="method public "><a href="#kill" title="kill :: Sets Session data to null, destroys session and deletes session cookie"><span class="description">Sets Session data to null, destroys session and deletes session cookie</span><pre>kill()</pre></a></li>
<li class="method public "><a href="#killAll" title="killAll :: "><span class="description">killAll()
        </span><pre>killAll()</pre></a></li>
<li class="method public "><a href="#reset" title="reset :: Regenerates ID, resets visit count and stores visit count in $_Session"><span class="description">Regenerates ID, resets visit count and stores visit count in $_Session</span><pre>reset()</pre></a></li>
<li class="method public "><a href="#set" title="set :: "><span class="description">set()
        </span><pre>set()</pre></a></li>
<li class="method public "><a href="#setUserData" title="setUserData :: "><span class="description">setUserData()
        </span><pre>setUserData()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#init" title="init :: "><span class="description">init()
        </span><pre>init()</pre></a></li>
<li class="method private "><a href="#resetCookie" title="resetCookie :: "><span class="description">resetCookie()
        </span><pre>resetCookie()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public "><a href="#%24data" title="$data :: "><span class="description">$data</span><pre>$data</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24sessionCookieExpireTime" title="$sessionCookieExpireTime :: "><span class="description">$sessionCookieExpireTime</span><pre>$sessionCookieExpireTime</pre></a></li>
<li class="property private "><a href="#%24sessionTimeout" title="$sessionTimeout :: "><span class="description">$sessionTimeout</span><pre>$sessionTimeout</pre></a></li>
<li class="property private "><a href="#%24visitCount" title="$visitCount :: "><span class="description">$visitCount</span><pre>$visitCount</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Clibrary%5CSession" id="\framework\library\Session"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.library.html">library</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.library.Session.html">Session</a>
</li>
</ul>
<div href="../classes/framework.library.Session.html" class="element class">
<p class="short_description">Session Class</p>
<div class="details">
<p class="long_description"><p>Manages all session activity</p></p>
<table class="table table-bordered">
<tr>
<th>todo</th>
<td>Finish Documentation</td>
</tr>
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\interfaces\Session_Interface</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\Front</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>__construct()
        </h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>get()
        </h2>
<pre>get($key) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code></code>
</div>
</div></div>
</div>
<a name="getUserData" id="getUserData"></a><div class="element clickable method public getUserData" data-toggle="collapse" data-target=".getUserData .collapse">
<h2>getUserData()
        </h2>
<pre>getUserData($key) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code></code>
</div>
</div></div>
</div>
<a name="kill" id="kill"></a><div class="element clickable method public kill" data-toggle="collapse" data-target=".kill .collapse">
<h2>Sets Session data to null, destroys session and deletes session cookie</h2>
<pre>kill($sid) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$sid</h4>
<code></code>
</div>
</div></div>
</div>
<a name="killAll" id="killAll"></a><div class="element clickable method public killAll" data-toggle="collapse" data-target=".killAll .collapse">
<h2>killAll()
        </h2>
<pre>killAll() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="reset" id="reset"></a><div class="element clickable method public reset" data-toggle="collapse" data-target=".reset .collapse">
<h2>Regenerates ID, resets visit count and stores visit count in $_Session</h2>
<pre>reset() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>set()
        </h2>
<pre>set($key, $data) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code></code>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code></code>
</div>
</div></div>
</div>
<a name="setUserData" id="setUserData"></a><div class="element clickable method public setUserData" data-toggle="collapse" data-target=".setUserData .collapse">
<h2>setUserData()
        </h2>
<pre>setUserData($data) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$data</h4>
<code></code>
</div>
</div></div>
</div>
<a name="init" id="init"></a><div class="element clickable method private init" data-toggle="collapse" data-target=".init .collapse">
<h2>init()
        </h2>
<pre>init() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="resetCookie" id="resetCookie"></a><div class="element clickable method private resetCookie" data-toggle="collapse" data-target=".resetCookie .collapse">
<h2>resetCookie()
        </h2>
<pre>resetCookie() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24data" id="$data"> </a><div class="element clickable property public $data" data-toggle="collapse" data-target=".$data .collapse">
<h2>$data</h2>
<pre>$data </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24sessionCookieExpireTime" id="$sessionCookieExpireTime"> </a><div class="element clickable property private $sessionCookieExpireTime" data-toggle="collapse" data-target=".$sessionCookieExpireTime .collapse">
<h2>$sessionCookieExpireTime</h2>
<pre>$sessionCookieExpireTime </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24sessionTimeout" id="$sessionTimeout"> </a><div class="element clickable property private $sessionTimeout" data-toggle="collapse" data-target=".$sessionTimeout .collapse">
<h2>$sessionTimeout</h2>
<pre>$sessionTimeout </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24visitCount" id="$visitCount"> </a><div class="element clickable property private $visitCount" data-toggle="collapse" data-target=".$visitCount .collapse">
<h2>$visitCount</h2>
<pre>$visitCount </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:44-05:00.<br></footer></div>
</div>
</body>
</html>
